Skip to content

Modernize the usage of the sphinx markup - #78

Open
matejak wants to merge 6 commits into
freeipa:mainfrom
matejak:sphinx
Open

matejak wants to merge 6 commits into
freeipa:mainfrom
matejak:sphinx

Conversation

@matejak

@matejak matejak commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

This huge PR aims to address the biggest pain of the documentation: Once it is generated, all links pointed to the freeipa website. As a result, it was difficult to browse it locally after building it.
While I was at it, nudged AI to make consistent use of code blocks, and to look at potential different issues.

I have separated this PR into commits that can be reviewed independently. The one with relative links is very very long, but full of trivial content.

The other commits are smaller, and either can be more easily reviewed by looking at the change, or by looking at the result.

In greater detail, here are the aims of the PR:

  1. Substitute absolute links with relative links. It decouples the documentation from the domain, and it also enables you to browse built documentation offline.
    This is done by the :doc: element when pages are linked, or with a :ref: element and a new anchor that the PR defines somewhere else.

  2. Fix code blocks - adhere to https://pigweed.dev/style/rest.html For script bodies, use bash, for sessions, use console. If session contains comments, those now got prompts that distinguish comments from command output.

  3. Add terminating newlines when they are missing (that's on many places actually)

  4. Include other enhancements that were proposed by an AI agent.

Use text and console text types when appropriate.
Fixes that didn't fit into other categories, and self-explanatory
The formatting in the file was heavily modified unlike other files.
Release is markdown-based, so it is treated differently
than its rst counterparts
Changes proposed by AI. They look sensible, less literal.
Use :doc: or new anchors + :ref: elements
@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

A preview of a4f6eb0 is uploaded and can be seen here:

🚀 https://freeipa.github.io/pull/78/ 🚀

Please note that it may take a moment for the latest changes to be reflected.

@duzda duzda left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @matejak, my local is ending with 1, you can see the same result in the pipeline, if we merge your changes now, it would immediately break the CI.

writing output... [100%] release-notes/4-9-14
/home/dhanina/Programming/freeipa.github.io/src/index.rst:7: WARNING: term not in glossary: 'realm' [ref.term]
/home/dhanina/Programming/freeipa.github.io/src/index.rst:63: WARNING: unknown document: '/release-notes/index' [ref.doc]
/home/dhanina/Programming/freeipa.github.io/src/page/Deployment_Recommendations.rst:23: WARNING: term not in glossary: 'trust' [ref.term]
/home/dhanina/Programming/freeipa.github.io/src/page/Deployment_Recommendations.rst:89: WARNING: term not in glossary: 'trust' [ref.term]
/home/dhanina/Programming/freeipa.github.io/src/page/Deployment_Recommendations.rst:229: WARNING: term not in glossary: 'trust' [ref.term]
/home/dhanina/Programming/freeipa.github.io/src/page/Deployment_Recommendations.rst:229: WARNING: term not in glossary: 'realm' [ref.term]
/home/dhanina/Programming/freeipa.github.io/src/index.rst:7: WARNING: term not in glossary: 'realm' [ref.term]
/home/dhanina/Programming/freeipa.github.io/src/index.rst:63: WARNING: unknown document: '/release-notes/index' [ref.doc]
/home/dhanina/Programming/freeipa.github.io/src/page/Quick_Start_Guide.rst:176: WARNING: term not in glossary: 'principal' [ref.term]
generating indices... genindex done
writing additional pages... search done
copying images... [100%] page/17-GALConfigurationTestSuccessCrop.png
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 35 warnings (with warnings treated as errors).
make: *** [Makefile:20: check] Error 1

@@ -33,7 +33,7 @@ jobs:
run: pip install -r requirements.txt

- name: Build pages

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Build pages and run linter

@@ -25,7 +25,7 @@ jobs:
run: pip install -r requirements.txt

- name: Build pages

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Build pages and run linter

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants